The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest430 COM module
 IForms::GetFirstObject method |
|||
|---|---|---|---|
|
Retrieves the first form space record.
VARIANT_FALSE is returned if the end of the record list is reached. |
 |
||
| C/C++ calling syntax |
|||
| HRESULT GetFirstObject( | BSTR
BSTR BSTR YesNoType BSTR VARIANT_BOOL |
*pbstrUID,
*pbstrOID, *pbstrName, *peIsFile, *pbstrFile, *pbStatus); |
|
| Calling argument description |
|||
| [out] BSTR | *pbstrUID | The UID of the form space node or PDF form template.
The UID might be empty if such an UID can not be found |
|
| [out] BSTR | *pbstrOID | The medForms OID of the form space node or PDF form template. Note that the supplied OID is always supplied in its shortened form ( e.g. medforms.20.30.5050)
This OID can be used in the IGeneralFormRequestManager::LoadPDF method to load this PDF template. |
|
| [out] BSTR | *pbstrName | The descriptive name of the form space node or PDF form template | |
| [out] YesNoType | *peIsFile | A Boolean denoting if the object is a node (enNo) or a PDF form template (enYes) | |
| [out] BSTR | *pbstrFile | The name of the PDF form template if eIsFile=enYes or empty otherwise
Alternatively to the OID this file name can be used in the IGeneralFormRequestManager::LoadPDF method to load this PDF template. |
|
| [out, retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |
| C/C++ return value |
|||
| S_OK | This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE. | ||
| S_FALSE | This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE. | ||
| E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||